home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / wbgames / hangman / hangman.guide (.txt) < prev    next >
Amigaguide Document  |  1996-04-07  |  13KB  |  272 lines
  1. @database hangman_help
  2. Hangman V1.3 (c) 1993 Arun Kumar G.P.
  3. Please use AmigaGuide or MultiView to read this document.
  4. @master hangman.guide
  5. @node main "Hangman.Doc"
  6.                               @{b}HANGMAN V1.3
  7.                           (c) 1993 Arun Kumar G.P.@{ub}
  8.                   _/          _/  _/_/_/_/    _/_/_/    _/_/_/
  9.                  _/          _/  _/        _/        _/
  10.        A        _/    _/    _/  _/_/_/    _/        _/          Production
  11.                  _/  _/  _/    _/        _/        _/
  12.                   _/  _/      _/_/_/_/    _/_/_/    _/_/_/
  13. This is the documentation for  'Hangman V1.3', a word guessing game for the
  14. Amiga computer.
  15.              @{" Introduction                        " link intro}
  16.              @{" Starting the Game                   " link startup}
  17.              @{" Playing the Game                    " link execution}
  18.              @{" Screen, Buttons & Menus             " link layout}
  19.              @{" About                               " link about}
  20.              @{" Compatibility, Acknowledgements etc " link misc}
  21.              @{" History                             " link history}
  22.              @{" To Do                               " link todo}
  23. @endnode
  24. @node intro "Introduction"
  25. Introduction :
  26. ==============
  27. This is a game based on the popular *NIX game.  The objective of the game
  28. is to guess correctly all the letters of a word in a maximum of 10
  29. attempts.
  30. A few features of this version of the game :
  31.  a. Can use a user supplied data file of words.
  32.  b. Both the keyboard and the mouse can be used to guess the words.
  33.  c. Can give hints if the user is stuck.
  34.  d. Online help in AmigaGuide hypertext format available.
  35.  e. Partly supports localization to default to the localized language.
  36.  f. Comes with 6 languages including English.
  37. @endnode
  38. @node startup "Starting the Game"
  39. Startup  :
  40. =========
  41.   The program can be executed from the WorkBench or from the CLI. It
  42. multitasks properly and runs in its own window.
  43.    From the CLI, you can specify the following optional command line
  44. arguments :
  45.   PUB/PUBSCREEN = Any available public screen on which to open the
  46.                   Hangman window. (Note that the name is case sensitive)
  47.                   If the Public screen is not available, the screen
  48.                   flashes and the window opens on the Workbench screen.
  49.                   Defaults to 'Workbench'.
  50.  LANG/LANGUAGE =  Should be any of the following :
  51.                     Deutsch
  52.                     English
  53.                     Espa
  54.                     Fran
  55.                     Nederlands
  56.                     Svenska
  57.                     default
  58.                   You can also specify the language that Hangman will use.
  59.                   If not specified or if it is 'default', the Locale
  60.                   language or English will be used. This is useful if you
  61.                   don't have Locale (OS 2.1 or greater) or you want to
  62.                   override the Locale language. The appropriate language
  63.                   data file will be used.
  64.   DATA/DATAFILE = You can also specify your own data file (full path name)
  65.                   to play with. This overrides any language you have
  66.                   specified.
  67.   From the Workbench the same tooltypes are supported. But additionally,
  68. you can also specify a data file by holding the shift key down and clicking
  69. once on the Hangman icon and double clicking on the data file icon. If you
  70. do not specify the data file or the language, it searches for the default
  71. file for that Locale (if supported by the OS) or defaults to searching for
  72. 'English.data' in the program's directory.  The uppercase equivalents of
  73. the words in the data file will be picked randomly for you to guess. Only
  74. words with characters a-z or A-Z and length less than 30 characters in
  75. size will be used.
  76. @endnode
  77. @node execution "Playing the Game"
  78. Playing  :
  79. =========
  80.   You start with a word picked randomly from the data file, all of whose
  81. letters are shown as hyphens (-).
  82.   - - - - -    (five letters to guess)
  83. If you guess a letter in the word correctly, they are filled in :
  84.   A M - - A    (two more letters to guess)
  85. You finish the game when you have guessed every letter in the word
  86.   A M I G A
  87. or when you have made 10 incorrect guesses.
  88. @endnode
  89. @node layout "Screens, Buttons and Menus"
  90. The Screen Layout :
  91. ==================
  92. - All letters that can be guessed are in the Unused letters box on the
  93.   left hand top corner of the window.  Once you guess a letter the
  94.   corresponding gadget in the Unused letters box will be ghosted. You
  95.   can guess a letter either by clicking on the letter button or by typing
  96.   the letter on the keyboard.
  97. - Below the Unused letter box is the actual word being guessed.
  98. - On the right hand top corner of the window is the scoreboard which shows
  99.   the number of games played, number of games won, percentage of wins,
  100.   the percentage accuracy and number of guesses to go before the game ends.
  101.   There is also a small picture of a man on the gallows which will be shown
  102.   in parts.
  103. - The bottom of the window has the following buttons :
  104.   SHOW ALL : If you cannot guess the word and you want to see that word
  105.              you can click on this button. The game ends and a new word is
  106.              picked from the file for the next game.
  107.   HINT     : If you are stuck and just want a hint, you can click on this
  108.              button. A random letter in the word will be shown and you
  109.              can continue to play the game but this won't be counted as a
  110.              win when you complete it. If you get hints for all the letters
  111.              in the word, a message will come up !!.
  112.   HELP     : If you have amigaguide.library installed in the LIBS:
  113.              directory and this file is in the directory in which the
  114.              executable resides, an amigaguide hyper text window with this
  115.              document opens to give you online help.
  116.   ABOUT    : Some details about the program and the author is shown.
  117.   EXIT     : Quit from the game.
  118. - The Menus :
  119.   Game :     Show All : Same as the above buttons
  120.              Hint     :         - DO -
  121.              Help     :         - DO -
  122.              About    :         - DO -
  123.              Iconize  : Closes the window and creates an icon in the
  124.                         Workbench window. If it is not possible to iconize,
  125.                         the screen will flash once.
  126.                         Double click on this icon to reopen the window and
  127.                         continue playing the previous game.
  128.                         
  129.              Exit     : Same as the above buttons
  130.   Language : This program can select words from different data files which
  131.              have words in the following languages.
  132.              Language          Data File Name Used
  133.              --------          -------------------
  134.              Deutsch           German.data
  135.              English           English.data
  136.              Espa
  137. ol           Spanish.data
  138.              Fran
  139. ais          French.data
  140.              Nederlands        Dutch.data
  141.              Svenska           Swedish.data
  142.              If the program is running on OS 2.1 or 3.0 which supports
  143.              localization, the program defaults to the Locale language
  144.              preference if it is one of the above.  It searches for the
  145.              data file in the program's directory and if not found then
  146.              defaults to 'English.data'.  If somebody is willing to do
  147.              the translation, all the English messages will be replaced
  148.              by the appropriate language messages.
  149.              On machines which do not support localization, it always
  150.              defaults to 'English.data' but it can be started with a
  151.              different language (or data file) or changed later in the
  152.              menus.
  153.              The menu items under this menu option lets you choose the
  154.              language you want and the appropriate data file will be
  155.              searched for and used. If the program has been started with
  156.              a startup data file, the 'Unknown' item will be enabled and
  157.              ticked. You can change the language any time you want as long
  158.              as the respective data files are present. You do not need to
  159.              have all the huge data files which come with this program and
  160.              you can have only the ones you play with in the program's
  161.              directory.
  162. @endnode
  163. @node about "About"
  164. About :
  165. ======
  166.    This is version 1.3 of Hangman. Hangman is copyright 
  167.  Arun Kumar
  168. 1993. See @{" History " link history} for a brief list of changes from previous releases.
  169. This is a shareware program and may be freely distributed, as long as
  170. all parts of the original distribution are kept intact. No profit may
  171. be made out of this program.  Only a small fee for the copying and/or
  172. the price  of  the  media is allowed.  All use is at your own risk.
  173. No liability or responsibility is assumed.
  174.    If you use it regularly please send 5 US Dollars or equivalent to the
  175. address given below. Bug Reports and feedbacks are also welcome.
  176.    Arun Kumar
  177.    27, Durand Road,
  178.    Earley, Reading RG6 2YU
  179.    Berkshire,
  180.    United Kingdom.
  181.    (Until May 1994)
  182.    E-Mail : A.KUMAR@REA2102.WINS.ICL.CO.UK
  183. My permanent address is
  184.    Arun Kumar
  185.    174/5C, 10th Cross,
  186.    Third Block, T.R. Nagar,
  187.    Bangalore 560028
  188.    INDIA
  189.    (But I am not sure whether I will be here after May 94, but any
  190.     correspondence will reach me after some time)
  191. This distribution of Hangman consists of the following files which must
  192. remain together and be intact:
  193.     Hangman.info
  194.     Hangman <dir>
  195.       Hangman
  196.       Hangman.info
  197.       Hangman.guide
  198.       Hangman.guide.info
  199.       English.data
  200.       Dutch.data
  201.       French.data
  202.       German.data
  203.       Spanish.data
  204.       Swedish.data
  205. @endnode
  206. @node misc "Compatibility, Acknowledgements etc."
  207. Miscellaneous :
  208. =============
  209. Hardware and Software Used :
  210.    Amiga 1200 HD, Additional Disk Drive and an old T.V.
  211.    GadToolsBox V2.0B
  212.    SAS C 6.3
  213.    VI editor (Yes! on the Amiga, I can't do without it)
  214. Compatibility :
  215.    This program will run only on Amigas with Workbench 2.0 and above. It
  216.    has not been tested on the Amiga 4000 (Big bucks!) but I am sure there
  217.    won't be any problems.  It also requires the asl.library and optionally
  218.    amigaguide.library to be in the LIBS: directory. The data file(s) for
  219.    the program should also be present in the same directory as the program.
  220. Acknowledgements :
  221. ----------------
  222.    The interface for this program was inspired by a similar one which I saw
  223.    running on MS Windows 3.1 for the IBM PC.
  224.    Thanks to
  225.       - Tom De Voeght (my pal on Internet and Beta Tester)
  226.       - Members of WECC (for their support)
  227.       - Nico Francais (for his Powerpacker group of utilities)
  228.       - Jan van den Baard (for his excellent GadToolsBox)
  229.       - Anders Bjerin (for the C Encyclopedia)
  230.       - Bram Moolenaar (for the VI editor)
  231.       - and to the Amiga, the best Computer I have ever worked on.
  232.    -  All other Copyrights acknowledged.
  233.    The data files were downloaded from 'ftp.denet.dk' (thanks to TDV) and
  234.    modified a bit. If you want more words or languages to play around with,
  235.    you can FTP from /pub/mirror1/wordlists directory in the above site.
  236. @endnode
  237. @node history "History"
  238. History :
  239. ========
  240. 24/10/93  V1.0     First working version.
  241. 30/10/93  V1.1     Added the small picture of the man on the gallows.
  242. 07/11/93  V1.2     Added Menus and support for 5 more languages. Included
  243.                    the data files to go with it. Also added 'Accuracy'.
  244.                    First public release (Aminet)
  245. 11/12/93  V1.3     Two bugs in display fixed : (Stupid of me !!)
  246.                    The Word to be guessed and the Image of the man were not
  247.                    being positioned correctly when other fonts were being
  248.                    used.
  249.                    Bands of colour appeared on the man in screens with more
  250.                    than 4 colours.
  251.                    Tooltypes (PUBSCREEN, LANGUAGE, DATAFILE) added.
  252.                    Added Iconize menu option.
  253.                    Can now open on any user specified Public Screen.
  254.                    Second Aminet release.
  255. @endnode
  256. @node todo "To Do"
  257. To Do:
  258. =====
  259.  a. Add different levels of play
  260.  b. Support and include more data files in other languages.
  261.  c. Support Powerpacked data files to save some space.
  262.  d. Support localization fully with all messages and gadgets shown in
  263.     different languages.
  264.     Is anybody willing to do the translation ?  If so please send me an
  265.     E-Mail or write to me.
  266.  e. Add sound samples.
  267.  - Do you have any more ideas ?
  268.   All this will be done, if I get a good response for this version. Other-
  269.   wise what is the point in me wasting my time on a program which people
  270.   do not support.
  271. @endnode
  272.